Skip to content

Creates Transfer Wrapped Assets guide #459

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 24 commits into from
Closed

Creates Transfer Wrapped Assets guide #459

wants to merge 24 commits into from
+46,178 −43,838

Conversation

dawnkelly09
Copy link
Collaborator

Description

This PR creates the Transfer Wrapped Assets guide for the Token Bridge product section. The demo project does the following:

  • This is an end-to-end example of manually transferring an arbitrary ERC-20 token from Moonbase Alpha to Ethereum Sepolia via Token Bridge. (Solana/Sui guide(s) will be created under separate PR)
  • Starts from creating a new project. I have a demo repository I'd like to ask Evgeni about sharing, but I can't until he returns. I wrote the guide to work without it, and will update as needed in a separate PR if we get the ok to use the repo
  • Uses the "loading your private key values from a secure keystore of your choice" approach to private keys
  • Flow: Transfer check for attestation --> dropdown with attestation steps for those who need it --> initiate transfer --> fetch VAA --> redeem VAA to complete transfer
  • TODO items: missing links to pending Token Bridge-related guides for Next Steps

Checklist

  • [x ] Required - I have added a label to this PR 🏷️
  • [ x] Required - I have run my changes through Grammarly
  • [ n/a ] If pages have been moved, I have created redirects in the wormhole-mkdocs repo

eshaben and others added 24 commits April 22, 2025 23:23
@eshaben
wip
7abbc0d
@eshaben
reorganize content to new structure
a690f89
@eshaben
Merge remote-tracking branch 'origin' into staging-new-ia
5dc1e37
@eshaben
update llms
a149aa9
@eshaben
add support for tool selector
990adbf
@eshaben
add logic so the dropdown closes when a user clicks anywhere else on …
99c55cc 
…the page
@eshaben
update messaging tutorial .pages file
66cbbdc
@eshaben
move ai resources to a directory
209f970
@martin0995 @dawnkelly09
Queries - Get Started page (#377)
ac88301 
* initial draft for queries

* initial queries draft

* grammarly check

* update file name

* add metadata

* add full script

* short description to steps

* rename title

* update script

* update based on feedback

* create snippet for queries

* move code to snippet

* rename sections

* Update products/queries/get-started.md

Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>

* update snippets path

* update title

* update intro

* link to queries package

* context of what Query Proxy is

* update style

* lowercase constants

* update expected output

* update links

* update titles

* Apply suggestions from code review

Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>

* update page based on feedback

---------

Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>
@martin0995 @dawnkelly09 @eshaben
NTT - Get Started page (#376)
02370ff 
* first draft of ntt setup

* update left hand menu order

* add file context

* Apply suggestions from code review

Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>

* update based on feedback

* grammarly check

* update links

* Apply suggestions from code review

Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>
Co-authored-by: Erin Shaben <eshaben@icloud.com>

* update metadata title

* update description metadata

* update metadata description

* update intro based on feedback

* remove update ntt cli section

* convert steps into ordered list

* update config file based on feedback

* update based on feedback

* update based on feedback

* Update products/native-token-transfers/get-started.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* update based on feedback

* add erc20 token deployment steps

---------

Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>
Co-authored-by: Erin Shaben <eshaben@icloud.com>
@eshaben
move tools
8c212e0
@dawnkelly09
Connect - Get Started page (#375)
7fe8e30 
* adds draft markdown

* updates based on feedback, handles snippet and image

* grammarly pass

* updates after seeing Martin's awesome draft!

* updated to use Sui --> Fuji repo from WH

* format snippet with prettier, updates to content per review feedback
@dawnkelly09 @eshaben @martin0995
Messaging - Get Started (#381)
ba6c0da 
* wip messaging get started

* wip it, wip it good!

* updates guide to complete steps, add terminal elements, and image

* adds TODOs to update with final repo addy when avail

* updates per feedback review and some resolved TODO items

* updates to use --privatekey option for Foundry keystore

* Apply suggestions from code review

Co-authored-by: Erin Shaben <eshaben@icloud.com>
Co-authored-by: Martin Hofmann <martin@papermoon.io>

* Update products/messaging/get-started.md

Co-authored-by: Martin Hofmann <martin@papermoon.io>

---------

Co-authored-by: Erin Shaben <eshaben@icloud.com>
Co-authored-by: Martin Hofmann <martin@papermoon.io>
@ilariae @dawnkelly09
Queries - Overview (#388)
2d9d111 
* page structure

* page content

* content

* Queries overview content

* add get started to timeline

* Update products/queries/overview.md

Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>

* Update products/queries/overview.md

Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>

* ccq server mention

---------

Co-authored-by: Ilaria Enache <ilaria@Mac.homenet.telecomitalia.it>
Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>
@ilariae @martin0995
@eshaben @dawnkelly09
Messaging - Overview (#387)
46a0fe9 
* Messaging verview

* use cases

* use cases

* use cases

* Update products/messaging/overview.md

Co-authored-by: Martin Hofmann <martin@papermoon.io>

* meta description

* Update products/messaging/overview.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Update products/messaging/overview.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Update products/messaging/overview.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Update products/messaging/overview.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* feedback

* timelines

* typo fix

* Remove .DS_Store from tracking

* Update products/messaging/overview.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* timeline

* Update products/messaging/overview.md

Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>

* Update products/messaging/overview.md

Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>

* Update products/messaging/overview.md

Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>

* Update products/messaging/overview.md

Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>

* Update products/messaging/overview.md

Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>

* next steps

* turn timeline into list

* Update products/messaging/overview.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

---------

Co-authored-by: Ilaria Enache <ilaria@Mac.homenet.telecomitalia.it>
Co-authored-by: Martin Hofmann <martin@papermoon.io>
Co-authored-by: Erin Shaben <eshaben@icloud.com>
Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>
@ilariae @martin0995
@dawnkelly09 @eshaben
Multigov - Overview (#397)
1411849 
* first draft multigov get started

* grammarly check

* add metadate description

* add tally links

* link to next sections

* update title and metadata

* Apply suggestions from code review

Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>

* reorg

* rewording

* rewording

* multigov overview page

* multigov overview page

* multigov overview page

* multigov timeline

* small fix

* Update .snippets/text/products/multigov/multigov-timeline.json

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Apply feedback

* move diagram to architecture page

* update timeline

* Apply suggestions from code review

Co-authored-by: Erin Shaben <eshaben@icloud.com>

---------

Co-authored-by: martin0995 <martin@papermoon.io>
Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>
Co-authored-by: Ilaria Enache <ilaria@Mac.homenet.telecomitalia.it>
Co-authored-by: Erin Shaben <eshaben@icloud.com>
@eshaben @martin0995
@dawnkelly09 @evgeniko @suhasamaresh @ilariae
Pull the latest changes into staging (#404)
cc3b7b9 
* update sdk to the latest version (#374)

* Add gitignore step (#372)

* add instructions for including .gitignore when starting fresh projects

* update llms

---------

Co-authored-by: Martin Hofmann <martin@papermoon.io>

* update sdk to latest version (#386)

* multiple ntt cli feedback adjustments (#389)

* multiple ntt cli feedback adjustments

* generate llms

* Update build/transfers/native-token-transfers/deployment-process/deploy-to-solana.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Update build/transfers/native-token-transfers/deployment-process/deploy-to-solana.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* re-generate llms files

---------

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Martinh/faq link in ntt (#384)

* add faws link to solana deployment page

* llms check

* update notes

* llm check

* Update build/transfers/native-token-transfers/deployment-process/deploy-to-solana.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* update based on feedback

* llm check

* action orientated link

* llm check

---------

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Martinh/settlement grammar fix (#391)

* fix(docs): fix grammar in unified liquidity paragraph (#390)

* grammarly check

* llm check

---------

Co-authored-by: Suhas A <113137561+suhasamaresh@users.noreply.github.com>

* remove Connect from product comparison table (#396)

* remove Connect from product comparison table

* llms check

---------

Co-authored-by: Ilaria Enache <ilaria@Mac.homenet.telecomitalia.it>

* Staked rpc comment & feature matrix adjustment (#402)

* staked rpc comment for ntt solana deploy

* adjust comment

* adjust feature support matrix for sui & aptos cctp

* re-generate llms files

---------

Co-authored-by: Martin Hofmann <martin@papermoon.io>
Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>
Co-authored-by: evgeniko <97796468+evgeniko@users.noreply.github.com>
Co-authored-by: Suhas A <113137561+suhasamaresh@users.noreply.github.com>
Co-authored-by: Ilaria <43253244+ilariae@users.noreply.github.com>
Co-authored-by: Ilaria Enache <ilaria@Mac.homenet.telecomitalia.it>
@martin0995 @dawnkelly09
@eshaben @ilariae
Multigov - Get Started page (#379)
2609cea 
* first draft multigov get started

* grammarly check

* add metadate description

* add tally links

* link to next sections

* update title and metadata

* Apply suggestions from code review

Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>

* reorg

* rewording

* rewording

* multigov overview page

* multigov overview page

* multigov overview page

* Update products/multigov/get-started.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* update metadata categories

* update intro and wording

* future proof update

* remove prerequisite

* update prerequisites

* multigov timeline

* remove step and update style

* small fix

* update supported chains

* update next steps

* add reference to token deployment

* add token specifications

* add link to overview

* Update .snippets/text/products/multigov/multigov-timeline.json

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Apply feedback

* move diagram to architecture page

* add deploymment flow

* unfinished timeline

* update timeline

* Update products/multigov/get-started.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Update products/multigov/get-started.md

* updated timeline

* fix capitalization

* Apply suggestions from code review

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Update .snippets/text/products/multigov/deployment-flow-timeline.json

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* update timeline

---------

Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>
Co-authored-by: Ilaria Enache <ilaria@Mac.homenet.telecomitalia.it>
Co-authored-by: Erin Shaben <eshaben@icloud.com>
Co-authored-by: Ilaria <43253244+ilariae@users.noreply.github.com>
@eshaben
remove dropdown js used for tools
086ed52
@ilariae
link fixes (#407)
6c018e6 
Co-authored-by: Ilaria Enache <ilaria@Mac.homenet.telecomitalia.it>
@martin0995 @dawnkelly09
@eshaben @ilariae
Typescript SDK - Get Started page (#380)
129ddc0 
* sdk first draft

* grammarly check

* adding description

* grammarly check

* update snippets

* update links

* update snippets

* updae introduction

* update title and metadata

* updates snippets to match new example

* prettier

* applies feedback per review. Next Steps is still TODO

* updates conclusion and next steps

* adds NTT Get Started to Next Steps

* mention advanced implementations in the introduction

* generalize for all types of users

* Apply suggestions from code review

Co-authored-by: Ilaria <43253244+ilariae@users.noreply.github.com>

* changed admonitions to "example" type r/t styling and look

---------

Co-authored-by: DAWN KELLY <dawnkelly09@gmail.com>
Co-authored-by: Erin Shaben <eshaben@icloud.com>
Co-authored-by: Ilaria <43253244+ilariae@users.noreply.github.com>
@martin0995 @dawnkelly09 @eshaben
Token Bridge - Get Started page (#382)
50001c0 
* initial commit

* create intro

* add Prerequisites

* project setup steps

* update link

* script to perform transaction

* next steps section

* grammarly check

* add wormholescan link

* Update products/token-bridge/get-started.md

Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>

* update wording

* update metadata description

* update introduction

* focus intro on token bridge

* update tone for guide

* turn sections into steps

* update link with todo

* reduce time to 5 minutes

* update next step description

* Apply suggestions from code review

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Update .snippets/code/products/token-bridge/get-started/snippet-1.ts

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* add keystore management note

* add step for key management

* specify networks

* generalize prerequisites

* add details to step

* lower transfer amount

* generalize function

* adapt page to automatic transfers

* update private key

* update section introduction

* update step

* update step

* remove item based on feedback

* update env references

* Update products/token-bridge/get-started.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* update comment

* update intro

* add description to step

* Update .snippets/code/products/token-bridge/get-started/snippet-1.ts

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* update comments on snippets

* update link

* update metadata

* llm check

---------

Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>
Co-authored-by: Erin Shaben <eshaben@icloud.com>
@dawnkelly09
adding snippets and terminal output, adds transfer steps
fa7d609
@dawnkelly09
grammarly and llms
5c28a7a
@dawnkelly09 dawnkelly09 added the A0 - New Content Pull request contains new content pages label Jun 10, 2025
@dawnkelly09 dawnkelly09 requested a review from eshaben as a code owner June 10, 2025 17:59
@dawnkelly09 dawnkelly09 added the B0 - Needs Review Pull request is ready for review label Jun 10, 2025
@dawnkelly09 dawnkelly09 requested a review from Copilot June 10, 2025 17:59
@dawnkelly09 dawnkelly09 requested a review from martin0995 June 10, 2025 17:59
Copilot
Copilot AI reviewed Jun 10, 2025
View reviewed changes
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR creates the "Transfer Wrapped Assets" guide for the Token Bridge product section while also updating in-page links throughout documentation to point to the new products paths.

  • Converts existing documentation link paths from /docs/build/... to /docs/products/...
  • Updates several guide and reference pages, ensuring consistency across Token Bridge, Native Token Transfers, Connect, MultiGov, and other related sections.

Reviewed Changes

Copilot reviewed 470 out of 470 changed files in this pull request and generated no comments.

Show a summary per file
File Description
..learn/transfers/cctp.md Updated links for CCTP and USDC bridging.
..learn/governance/overview.md Updated link to MultiGov Architecture page.
..learn/glossary.md Updated reference links for chain IDs, finality, and VAAs.
..build/transfers/token-bridge.md Updated prerequisites and link paths for Token Bridge.
..build/transfers/native-token-transfers/index.md Updated links for NTT CLI Commands and FAQs.
..build/transfers/native-token-transfers/deployment-process/post-deployment.md Updated links for Wormhole Connect and TypeScript SDK.
..build/transfers/native-token-transfers/deployment-process/installation.md Updated links for NTT CLI Commands and NTT deployment guides.
..build/transfers/connect/overview.md Updated multiple links for Connect routes, configuration and features.
..build/transfers/connect/index.md Updated links for tutorials, FAQs, and supported features of Connect.
..build/transfers/cctp.md Updated links for CCTP contract addresses and chain IDs.
..build/toolkit/faqs.md Updated link for TokenBridge contract addresses.
..build/toolkit/dev-env.md Updated links for supported networks in dev environment setup.
..build/start-building/use-cases.md Updated product links for various Wormhole use cases.
..build/queries/use-queries.md Updated link for the Core Contract address in queries guide.
..build/queries/overview.md Updated FAQ link for queries.
..build/multigov/index.md Updated links for deploying and upgrading MultiGov.
..build/core-messaging/index.md Updated links for Supported Networks and messaging guides.

@dawnkelly09 dawnkelly09 marked this pull request as draft June 10, 2025 18:01
@dawnkelly09 dawnkelly09 mentioned this pull request Jun 10, 2025
Open
@dawnkelly09
Copy link
Collaborator Author

No longer needed. All changes are included in PR #461

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

Copilot code review Copilot Copilot left review comments

@eshaben eshaben Awaiting requested review from eshaben eshaben is a code owner

@0xlukem 0xlukem Awaiting requested review from 0xlukem 0xlukem is a code owner

@Telucero Telucero Awaiting requested review from Telucero Telucero is a code owner

@martin0995 martin0995 Awaiting requested review from martin0995

Assignees
No one assigned
Labels
A0 - New Content Pull request contains new content pages B0 - Needs Review Pull request is ready for review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@dawnkelly09 @eshaben @martin0995 @ilariae